WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.OAuth Authentication
Allow CAS to act as an OAuth authentication provider. Please review the specification to learn more.
This page specifically describes how to enable OAuth/OpenID server support for CAS. If you would like to have CAS act as an OAuth/OpenID client communicating with other providers (such as Google, Facebook, etc), see this page.
Actuator Endpoints
The following endpoints are provided by CAS:
Delete token by id.
|
org.apereo.cas.support.oauth.web.mgmt.OAuth20TokenManagementEndpoint |
Get single token by id.
Ticket |
|
org.apereo.cas.support.oauth.web.mgmt.OAuth20TokenManagementEndpoint |
Get access and/or refresh tokens.
Collection |
|
org.apereo.cas.support.oauth.web.mgmt.OAuth20TokenManagementEndpoint |
Configuration
Support is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-oauth-webflow</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-oauth-webflow:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-oauth-webflow"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.oauth.access-token.crypto.encryption.key=
The encryption key is a JWT whose length is defined by the encryption key size setting. |
cas.authn.oauth.access-token.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.authn.oauth.crypto.encryption.key=
The encryption key is a JWT whose length is defined by the encryption key size setting. |
cas.authn.oauth.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.authn.oauth.csrf-cookie.comment=CAS Cookie
CAS Cookie comment, describes the cookie's usage and purpose. |
cas.authn.oauth.csrf-cookie.domain=
Cookie domain. Specifies the domain within which this cookie should be presented. The form of the domain name is specified by RFC 2965. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them. |
cas.authn.oauth.csrf-cookie.http-only=true
true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript. |
cas.authn.oauth.csrf-cookie.max-age=-1
The maximum age of the cookie, specified in seconds. By default, |
cas.authn.oauth.csrf-cookie.name=
Cookie name. Constructs a cookie with a specified name and value. The name must conform to RFC 2965. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a |
cas.authn.oauth.csrf-cookie.path=
Cookie path. Specifies a path for the cookie to which the client should return the cookie. The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog. Consult RFC 2965 (available on the Internet) for more information on setting path names for cookies. |
cas.authn.oauth.csrf-cookie.same-site-policy=
If a cookie is only intended to be accessed in a first party context, the developer has the option to apply one of settings SameSite=None, to designate cookies for cross-site access. When the SameSite=None attribute is present, an additional Secure attribute is used so cross-site cookies can only be accessed over HTTPS connections. Accepted values are:
|
cas.authn.oauth.csrf-cookie.secure=true
True if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol. |
cas.authn.oauth.access-token.crypto.alg=
The signing/encryption algorithm to use. |
cas.authn.oauth.access-token.crypto.enabled=true
Whether crypto operations are enabled. |
cas.authn.oauth.access-token.crypto.encryption-enabled=true
Whether crypto encryption operations are enabled. |
cas.authn.oauth.access-token.crypto.encryption.key-size=512
The encryption key size. |
cas.authn.oauth.access-token.crypto.signing-enabled=true
Whether crypto signing operations are enabled. |
cas.authn.oauth.access-token.crypto.signing.key-size=512
The signing key size. |
cas.authn.oauth.access-token.crypto.strategy-type=ENCRYPT_AND_SIGN
Control the cipher sequence of operations. The accepted values are:
|
cas.authn.oauth.crypto.alg=
The signing/encryption algorithm to use. |
cas.authn.oauth.crypto.enabled=true
Whether crypto operations are enabled. |
cas.authn.oauth.crypto.encryption-enabled=true
Whether crypto encryption operations are enabled. |
cas.authn.oauth.crypto.encryption.key-size=512
The encryption key size. |
cas.authn.oauth.crypto.signing-enabled=true
Whether crypto signing operations are enabled. |
cas.authn.oauth.crypto.signing.key-size=512
The signing key size. |
cas.authn.oauth.crypto.strategy-type=ENCRYPT_AND_SIGN
Control the cipher sequence of operations. The accepted values are:
|
cas.authn.oauth.access-token.create-as-jwt=false
Create access token as JWTs. |
cas.authn.oauth.access-token.max-time-to-live-in-seconds=PT28800S
Hard timeout to kill the access token and expire it. This settings supports the
|
cas.authn.oauth.access-token.storage-name=oauthAccessTokensCache
The storage object name used and created by CAS to hold OAuth access tokens in the backing ticket registry implementation. |
cas.authn.oauth.access-token.time-to-kill-in-seconds=PT7200S
Sliding window for the access token expiration policy. Essentially, this is an idle time out. This settings supports the
|
cas.authn.oauth.code.number-of-uses=1
Number of times this code is valid and can be used. |
cas.authn.oauth.code.remove-related-access-tokens=false
Remove the related access tokens when trying to use a code which is expired or no longer exists. |
cas.authn.oauth.code.storage-name=oauthCodesCache
The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation. |
cas.authn.oauth.code.time-to-kill-in-seconds=30
Duration in seconds where the code is valid. |
cas.authn.oauth.core.bypass-approval-prompt=false
Whether approval prompt/consent screen should be bypassed. |
cas.authn.oauth.core.user-profile-view-type=NESTED
User profile view type determines how the final user profile should be rendered once an access token is "validated". Available values are as follows:
|
cas.authn.oauth.device-token.max-time-to-live-in-seconds=PT5M
Hard timeout to kill the device token and expire it. This settings supports the
|
cas.authn.oauth.device-token.refresh-interval=PT15S
The device refresh interval. The client should attempt to acquire an access token every few seconds (at a rate specified by interval) by POSTing to the access token endpoint on the server. This settings supports the
|
cas.authn.oauth.device-token.storage-name=oauthDeviceTokensCache
The storage object name used and created by CAS to hold OAuth device tokens in the backing ticket registry implementation. |
cas.authn.oauth.device-user-code.max-time-to-live-in-seconds=PT1M
Hard timeout to kill the token and expire it. This settings supports the
|
cas.authn.oauth.device-user-code.storage-name=oauthDeviceUserCodesCache
The storage object name used and created by CAS to hold OAuth device user codes in the backing ticket registry implementation. |
cas.authn.oauth.device-user-code.user-code-length=8
Length of the generated user code. |
cas.authn.oauth.grants.resource-owner.require-service-header=false
Whether using the resource-owner grant should enforce authorization rules and per-service policies based on a service parameter is provided as a header outside the normal semantics of the grant and protocol. |
cas.authn.oauth.refresh-token.storage-name=oauthRefreshTokensCache
The storage object name used and created by CAS to hold OAuth refresh tokens in the backing ticket registry implementation. |
cas.authn.oauth.refresh-token.time-to-kill-in-seconds=P14D
Hard timeout beyond which the refresh token is considered expired. This settings supports the
|
cas.authn.oauth.replicate-sessions=false
Indicates whether profiles and other session data, collected as part of OAuth flows and requests that are kept by the container session, should be replicated across the cluster using CAS and its own ticket registry. Without this option, OAuth profile data and other related pieces of information should be manually replicated via means and libraries outside of CAS. |
cas.authn.oauth.access-token.crypto.encryption.key=
The encryption key is a JWT whose length is defined by the encryption key size setting. |
cas.authn.oauth.access-token.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.authn.oauth.crypto.encryption.key=
The encryption key is a JWT whose length is defined by the encryption key size setting. |
cas.authn.oauth.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.authn.oauth.access-token.crypto.alg=
The signing/encryption algorithm to use. |
cas.authn.oauth.access-token.crypto.enabled=true
Whether crypto operations are enabled. |
cas.authn.oauth.access-token.crypto.encryption-enabled=true
Whether crypto encryption operations are enabled. |
cas.authn.oauth.access-token.crypto.encryption.key-size=512
The encryption key size. |
cas.authn.oauth.access-token.crypto.signing-enabled=true
Whether crypto signing operations are enabled. |
cas.authn.oauth.access-token.crypto.signing.key-size=512
The signing key size. |
cas.authn.oauth.access-token.crypto.strategy-type=ENCRYPT_AND_SIGN
Control the cipher sequence of operations. The accepted values are:
|
cas.authn.oauth.crypto.alg=
The signing/encryption algorithm to use. |
cas.authn.oauth.crypto.enabled=true
Whether crypto operations are enabled. |
cas.authn.oauth.crypto.encryption-enabled=true
Whether crypto encryption operations are enabled. |
cas.authn.oauth.crypto.encryption.key-size=512
The encryption key size. |
cas.authn.oauth.crypto.signing-enabled=true
Whether crypto signing operations are enabled. |
cas.authn.oauth.crypto.signing.key-size=512
The signing key size. |
cas.authn.oauth.crypto.strategy-type=ENCRYPT_AND_SIGN
Control the cipher sequence of operations. The accepted values are:
|
This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.
Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:
1
2
wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]
The outcome would be similar to:
1
2
3
4
5
{
"kty": "oct",
"kid": "...",
"k": "..."
}
The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via
the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a
specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in
lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.
Endpoints
After enabling OAuth support, the following endpoints will be available:
| Endpoint | Description | Method |
|---|---|---|
/oauth2.0/authorize |
Authorize the user and start the CAS authentication flow. | GET |
/oauth2.0/accessToken,/oauth2.0/token |
Get an access token in plain-text or JSON | POST |
/oauth2.0/profile |
Get the authenticated user profile in JSON via access_token parameter. |
GET |
/oauth2.0/introspect |
Query CAS to detect the status of a given access token via introspection. This endpoint expects HTTP basic authentication with OAuth2 service client_id and client_secret associated as username and password. |
POST |
/oauth2.0/device |
Approve device user codes via the device flow protocol. | POST |
/oauth2.0/revoke |
Revoke access or refresh tokens. This endpoint expects HTTP basic authentication with OAuth2 service client_id and client_secret associated as username and password. |
 |
Response/Grant Types
The following types are supported; they allow you to get an access token representing the current user and OAuth
client application. With the access token, you’ll be able to query the /profile endpoint and get the user profile.
Authorization Code
The authorization code type is made for UI interactions: the user will enter credentials, shall receive a code and will exchange that code for an access token.
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/authorize |
response_type=code&client_id=<ID>&redirect_uri=<CALLBACK> |
OAuth code as a parameter of the CALLBACK url. |
/oauth2.0/accessToken |
grant_type=authorization_code&client_id=ID&client_secret=SECRET&code=CODE&redirect_uri=CALLBACK |
The access token. |
Proof Key Code Exchange (PKCE)
The Proof Key for Code Exchange (PKCE, pronounced pixie) extension describes a technique for public clients to mitigate the threat of having the authorization code intercepted. The technique involves the client first creating a secret, and then using that secret again when exchanging the authorization code for an access token. This way if the code is intercepted, it will not be useful since the token request relies on the initial secret.
The authorization code type at the authorization endpoint /oauth2.0/authorize is able to accept the following parameters to activate PKCE:
| Parameter | Description |
|---|---|
code_challenge |
The code challenge generated using the method below. |
code_challenge_method |
plain, S256. This parameter is optional, where plain is assumed by default. |
The /oauth2.0/accessToken endpoint is able to accept the following parameters to activate PKCE:
| Parameter | Description |
|---|---|
code_verifier |
The original code verifier for the PKCE request, that the app originally generated before the authorization request. |
If the method is plain, then the CAS needs only to check that the provided code_verifier matches the expected code_challenge string.
If the method is S256, then the CAS should take the provided code_verifier and transform it using the same method the client will have used initially. This means calculating the SHA256 hash of the verifier and base64-url-encoding it, then comparing it to the stored code_challenge.
If the verifier matches the expected value, then the CAS can continue on as normal, issuing an access token and responding appropriately.
Token/Implicit
The token type is also made for UI interactions as well as indirect non-interactive (i.e. Javascript) applications.
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/authorize |
response_type=token&client_id=ID&redirect_uri=CALLBACK |
The access token as an anchor parameter of the CALLBACK url. |
Resource Owner Credentials
The password grant type allows the OAuth client to directly send the user’s credentials to the OAuth server.
This grant is a great user experience for trusted first party clients both on the web and in native device applications.
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/accessToken |
grant_type=password&client_id=ID&client_secret=<SECRET>&username=USERNAME&password=PASSWORD |
The access token. |
Because there is no redirect_uri specified by this grant type, the service identifier recognized by CAS and matched in the service registry is taken as the client_id instead. You may optionally also pass along a service or X-service header value that identifies the target application url. The header value must match the OAuth service definition in the registry that is linked to the client id.
Client Credentials
The simplest of all of the OAuth grants, this grant is suitable for machine-to-machine authentication where a specific user’s permission to access data is not required.
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/accessToken |
grant_type=client_credentials&client_id=client&client_secret=secret |
The access token. |
Because there is no redirect_uri specified by this grant type, the service identifier recognized by CAS and matched in the service registry is taken as the client_id instead. You may optionally also pass along a service or X-service header value that identifies the target application url. The header value must match the OAuth service definition in the registry that is linked to the client id.
Refresh Token
The refresh token grant type retrieves a new access token from a refresh token (emitted for a previous access token), when this previous access token is expired.
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/accessToken |
grant_type=refresh_token&client_id=<ID>&client_secret=SECRET&refresh_token=REFRESH_TOKEN |
The new access token. |
Device Flow
| Endpoint | Parameters | Response |
|---|---|---|
/oauth2.0/accessToken |
response_type=device_code&client_id=<ID> |
Device authorization url, device code and user code. |
/oauth2.0/accessToken |
response_type=device_code&client_id=<ID>&code=<DEVICE_CODE> |
New access token once the user code is approved. |
Grant Type Selection
A grant is a method of acquiring an access token. Deciding which grants to implement depends on the type of client the end user will be using, and the experience you want for your users.
To learn more about profiles and grant types, please review this guide.
Client Registration
Please see this guide.
OAuth Token Expiration Policy
Please see this guide.
JWT Access Tokens
By default, OAuth access tokens are created as opaque identifiers. There is also the option to generate JWTs as access tokens on a per-service basis:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
"clientId": "clientid",
"clientSecret": "clientSecret",
"serviceId" : "^(https|imaps)://<redirect-uri>.*",
"name" : "OAuthService",
"id" : 100,
"jwtAccessToken": true,
"properties" : {
"@class" : "java.util.HashMap",
"accessTokenAsJwtSigningKey" : {
"@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
"values" : [ "java.util.HashSet", [ "..." ] ]
},
"accessTokenAsJwtEncryptionKey" : {
"@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
"values" : [ "java.util.HashSet", [ "..." ] ]
},
"accessTokenAsJwtSigningEnabled" : {
"@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
"values" : [ "java.util.HashSet", [ "true" ] ]
},
"accessTokenAsJwtEncryptionEnabled" : {
"@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
"values" : [ "java.util.HashSet", [ "true" ] ]
},
"accessTokenAsJwtCipherStrategyType" : {
"@class" : "org.apereo.cas.services.DefaultRegisteredServiceProperty",
"values" : [ "java.util.HashSet", [ "ENCRYPT_AND_SIGN" ] ]
}
}
}
Signing and encryption keys may also be defined on a per-service basis, or globally via CAS settings.
The following properties are available and recognized by CAS for various modules and features:
| Name | Default Value | Type | Group |
|---|---|---|---|
accessTokenAsJwtSigningKey
|
|
STRING
|
JWT_ACCESS_TOKENS
|
accessTokenAsJwtCipherStrategyType
|
ENCRYPT_AND_SIGN
|
STRING
|
JWT_ACCESS_TOKENS
|
accessTokenAsJwtSigningEnabled
|
true
|
BOOLEAN
|
JWT_ACCESS_TOKENS
|
accessTokenAsJwtEncryptionEnabled
|
false
|
BOOLEAN
|
JWT_ACCESS_TOKENS
|
accessTokenAsJwtEncryptionKey
|
|
STRING
|
JWT_ACCESS_TOKENS
|
OAuth User Profile Structure
Please see this guide.
Throttling
Authentication throttling may be enabled for the /oauth2.0/accessToken provided support
is included in the overlay to turn on authentication
throttling support. The throttling
mechanism that handles the usual CAS server endpoints for authentication
and ticket validation, etc is then activated for the OAuth
endpoints that are supported for throttling.
CSRF Cookie Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.authn.oauth.csrf-cookie.comment=CAS Cookie
CAS Cookie comment, describes the cookie's usage and purpose. |
cas.authn.oauth.csrf-cookie.domain=
Cookie domain. Specifies the domain within which this cookie should be presented. The form of the domain name is specified by RFC 2965. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them. |
cas.authn.oauth.csrf-cookie.http-only=true
true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript. |
cas.authn.oauth.csrf-cookie.max-age=-1
The maximum age of the cookie, specified in seconds. By default, |
cas.authn.oauth.csrf-cookie.name=
Cookie name. Constructs a cookie with a specified name and value. The name must conform to RFC 2965. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a |
cas.authn.oauth.csrf-cookie.path=
Cookie path. Specifies a path for the cookie to which the client should return the cookie. The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog. Consult RFC 2965 (available on the Internet) for more information on setting path names for cookies. |
cas.authn.oauth.csrf-cookie.same-site-policy=
If a cookie is only intended to be accessed in a first party context, the developer has the option to apply one of settings SameSite=None, to designate cookies for cross-site access. When the SameSite=None attribute is present, an additional Secure attribute is used so cross-site cookies can only be accessed over HTTPS connections. Accepted values are:
|
cas.authn.oauth.csrf-cookie.secure=true
True if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol. |
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in
lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.
Server Configuration
Remember that OAuth features of CAS require session affinity (and optionally session replication), as the authorization responses throughout the login flow are stored via server-backed session storage mechanisms. You will need to configure your deployment environment and load balancers accordingly.
Session Replication
The following settings and properties are available from the CAS configuration catalog:
cas.session-replication.cookie.allowed-ip-addresses-pattern=
A regular expression pattern that indicates the set of allowed IP addresses, when |
cas.session-replication.cookie.auto-configure-cookie-path=true
Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured. |
cas.session-replication.cookie.comment=CAS Cookie
CAS Cookie comment, describes the cookie's usage and purpose. |
cas.session-replication.cookie.domain=
Cookie domain. Specifies the domain within which this cookie should be presented. The form of the domain name is specified by RFC 2965. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them. |
cas.session-replication.cookie.http-only=true
true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript. |
cas.session-replication.cookie.max-age=-1
The maximum age of the cookie, specified in seconds. By default, |
cas.session-replication.cookie.name=
Cookie name. Constructs a cookie with a specified name and value. The name must conform to RFC 2965. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a |
cas.session-replication.cookie.path=
Cookie path. Specifies a path for the cookie to which the client should return the cookie. The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog. Consult RFC 2965 (available on the Internet) for more information on setting path names for cookies. |
cas.session-replication.cookie.pin-to-session=true
When generating cookie values, determine whether the value should be compounded and signed with the properties of the current session, such as IP address, user-agent, etc. |
cas.session-replication.cookie.same-site-policy=
If a cookie is only intended to be accessed in a first party context, the developer has the option to apply one of settings SameSite=None, to designate cookies for cross-site access. When the SameSite=None attribute is present, an additional Secure attribute is used so cross-site cookies can only be accessed over HTTPS connections. Accepted values are:
|
cas.session-replication.cookie.secure=true
True if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol. |
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in
lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.